home *** CD-ROM | disk | FTP | other *** search
/ 17 Bit Software 3: The Continuation / 17-Bit_The_Continuation_Disc.iso / amigan / amigan 15 / keep / keep.doc < prev    next >
Encoding:
Text File  |  1994-01-27  |  7.2 KB  |  191 lines
  1.  
  2.                                   G'day!
  3.                             And welcome to...
  4.  
  5.  
  6.                                 Keep v0.9
  7.  
  8.  
  9.          Keep is a utility program for BBS and network junkies like
  10.     myself who download messages in one large file and then read them
  11.     off-line. Using only the mouse, you can drive through such files a
  12.     message at a time, examine each at your leisure and tag those you
  13.     wish to keep. When the entire file has been examined, Keep goes
  14.     through the file once more and stores those messages that have been
  15.     so tagged. The original file is left intact.
  16.  
  17.  
  18.          The program is currently runnable only from the CLI. You can
  19.     invoke it in a number of ways. The recommended one is as follows:
  20.  
  21.                   run keep
  22.  
  23.     This program uses Charlie Heath's excellent file requester to pick
  24.     the file to be examined. Believe me, it's a lot faster than typing
  25.     it in.
  26.  
  27.     However, you can specify the source file from the CLI thusly:
  28.  
  29.                   run keep message_file
  30.  
  31.     This will examine the file message_file and store the messages to be
  32.     kept in the file message_file.kpt, in the directory where the source
  33.     file resides.
  34.  
  35.     If you wish to cross directories, you can enter, for example
  36.  
  37.                   run keep df1:message_file to df0:file_name
  38.  
  39.     The .kpt extension will be automatically appended to the destination
  40.     file name. However, you must specify a destination file name! Simply
  41.     entering, for example,
  42.  
  43.                   run keep df1:message_file to df0:
  44.  
  45.     will not work.
  46.  
  47.  
  48.          Keep opens its own screen to the same size as the Workbench
  49.     screen (640 x 200 or larger). This is handy if you are using
  50.     morerows or interlace to get a larger display area.
  51.  
  52.          Keep assumes that message files consist of lines of no more
  53.     than 120 characters, ending with CR and/or LF. Any non-text
  54.     character contained in the line before the CR/LF will be displayed
  55.     -- usually as a rectangle; the CR/LF do not appear. They are,
  56.     however, left intact.
  57.  
  58.          Once running, keep is (or should be) self-explanatory. A
  59.     possible source of ambiguity is the gadgets at the top of the
  60.     window. Selection of the arrows pointing up and down permit the user
  61.     to page through the text of the message. The KEEP and DUMP gadgets
  62.     tag the message and advance to the next message. You can select the
  63.     left-pointing arrow to back up to the previous message. Here you can
  64.     change the fate of the message by selecting the appropriate KEEP or
  65.     DUMP gadget. However, you must return to the current message by
  66.     selecting the right-pointing arrow before you can move on to the
  67.     next message in the file.
  68.  
  69.  
  70.          You can at any time change the name of the destination file by
  71.     selecting To... under the Project menu.
  72.  
  73.          Skip terminates examination of the current file and saves what
  74.     messages had been tagged up to that point.
  75.  
  76.          Abort terminates examination of the current file completely and
  77.     restarts the program.
  78.  
  79.          About provides some speculation as to the inspiration of the
  80.     Guru's meditations...
  81.  
  82.          And Quit exits the program.
  83.  
  84.  
  85.          Keep does not have to be used exclusively for information
  86.     services. It can work with any text database that uses a repeating
  87.     header at the beginning of each record and fields of no more than
  88.     120 characters delimited with CR and/or LF. It looks for a key
  89.     string of five characters or less -- the shorter the string, the
  90.     faster the search. You can see which ones I have chosen: each time a
  91.     network gadget is selected in the service requester, the Key string
  92.     string gadget is updated. You can click on this gadget to customize
  93.     the key string.
  94.  
  95.  
  96.          If the program encounters a read error in the message file, it
  97.     will save those  messages currently tagged and offer to restart the
  98.     program -- in other words, it will behave as if you had selected the
  99.     Skip option.
  100.  
  101.          If the program encounters an error during the writing of the
  102.     destination file, it will close that file and save to ram: instead
  103.     -- very handy if you just spent four hours going through 700+
  104.     messages. In this case, however, the default destination file name
  105.     will be used.
  106.  
  107.  
  108.     Enhancements to future versions of Keep may include:
  109.  
  110.          1. Much more attractive, Image-rendered gadgets.
  111.  
  112.          2. Workbench support.
  113.  
  114.          3. CLI and menu support for interlace.
  115.  
  116.          4. More polished mutual exclude in the service requester.
  117.  
  118.          5. Support for other fonts.
  119.  
  120.          6. Depth arrangement gadgets. The screen can be pulled down
  121.             in this version -- two pixels of the screen behind are
  122.             there to grab.
  123.  
  124.          7. Support for other BBSs and networks.
  125.  
  126.          8. Support for arbitrarily large files and messages. In this
  127.             version, Keep is confined to files containing up to 2000
  128.             messages or records. In addition, it reads in no more than
  129.             1000 lines at a time. This latter aspect does not compromise
  130.             the operation of the program should the message be larger
  131.             than 1000 lines. It simply splits it into smaller pieces.
  132.             If you want to save a complete message, save all the pieces.
  133.  
  134.          9. More elegant command line parsing.
  135.  
  136.          10. The ability to use the mouse to mark portions of
  137.              messages for keeping.
  138.  
  139.          11. Word wrap for lines longer than 80 characters.
  140.  
  141.          12. Scrolling, rather than paging of text.
  142.  
  143.          13. A proportional gadget to indicate the current position in
  144.              the source file.
  145.  
  146.  
  147.          The shareware program blitzfonts works with Keep and is highly
  148.     recommended.
  149.  
  150.  
  151.          Known bugs: Only one, that I know of, and rather obscure. If
  152.     you were to click on the left-pointing arrow to review the previous
  153.     message, and that message had been longer than 1000 lines and
  154.     consequently truncated, the program will go into an endless loop if
  155.     you page down to the end of the message. For some reason I have yet
  156.     to fathom, the null pointer that marks the end of the buffer
  157.     vanishes and my pageprint() function gets lost.
  158.  
  159.          I would like to thank Charlie Heath, William Volk, and Chris
  160.     Zamara for their help. I especially would like to thank the real
  161.     Nick Sullivan, for his endlessly patient assistance. Keep is a
  162.     direct descendant, several generations removed, of a program Nick
  163.     wrote in CBM Basic and 6502 ML for the C64 and PET 8032.
  164.  
  165.  
  166.          My greatest debt is to my wife Cate and my son Alex, for their
  167.     love.  (Oh Puke Puke!!  C.R.Larcombe)
  168.  
  169.  
  170.     Copyright Notice: Keep is copyright (c) 1987 by Tim Grantham. It may
  171.     not be copied, nor sold for profit, nor altered in any way, without
  172.     the permission of the author. Said author may be reached at:
  173.  
  174.          55 Sorauren Ave.
  175.          Toronto, Ontario
  176.          Canada. M6R 2C9
  177.  
  178.          (416) 535-1721
  179.  
  180.          or on:
  181.  
  182.          PeopleLink: AMTAG
  183.          BIX: dispatcher
  184.          GEnie: t.grantham
  185.          CIS: 71426,1646
  186.  
  187.  
  188.     Subscribe to The Transactor for the Amiga, for the best in Amiga
  189.     coverage, including Amiga Dispatches by yours truly. The Transactor
  190.     also operates the Commodore forums CBMPRG and CBMCOM on Compuserve.
  191.